Skip to content

Update README & docs#347

Merged
j-atkins merged 7 commits into
mainfrom
readme-docs
Jun 2, 2026
Merged

Update README & docs#347
j-atkins merged 7 commits into
mainfrom
readme-docs

Conversation

@j-atkins
Copy link
Copy Markdown
Collaborator

This PR updates project owner details, development status (I think "beta" is now a more accurate reflection), some phrasing and formatting in the README, which in turn is also incorporated into the docs.

Closes #344

@j-atkins j-atkins requested review from ammedd and erikvansebille May 28, 2026 15:00
Copy link
Copy Markdown
Member

@erikvansebille erikvansebille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good; two small comments below

Comment thread docs/conf.py Outdated
project = "VirtualShip Parcels"
copyright = "2024, Emma Daniëls"
author = "Emma Daniëls"
copyright = "2024, VirtualShip Team"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be 2026?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed this but @ammedd thought it 2024 makes sense given that's when the project started

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update: now removed

Comment thread README.md Outdated
<!-- Insert catchy summary -->

VirtualShip is a command line simulator allowing students to plan and conduct a virtual research expedition, receiving measurements as if they were coming from actual oceanographic instruments including:
VirtualShip is a command line simulator allowing scientists to plan and conduct a research expedition in a digital ocean, receiving measurements as if they were coming from actual oceanographic instruments including:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More generic "users" instead of "scientists"?

@j-atkins j-atkins merged commit bd7dbd2 into main Jun 2, 2026
11 checks passed
@j-atkins j-atkins deleted the readme-docs branch June 2, 2026 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README

2 participants